home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Amiga Tools 2
/
Amiga Tools 2.iso
/
tools
/
qtools
/
qtlibrary
/
quicktools.doc
next >
Wrap
Text File
|
1995-03-09
|
6KB
|
253 lines
TABLE OF CONTENTS
quicktools.library/FindMatchReq
quicktools.library/FindNextMatch
quicktools.library/FreeMatchData
quicktools.library/LockQToolsData
quicktools.library/SetupMatchData
quicktools.library/UnLockQToolsData
quicktools.library/FindMatchReq quicktools.library/FindMatchReq
NAME
FindMatchReq -- Scan for matches, and show them in a requester.
SYNOPSIS
name = FindMatchReq( match, buffer, len, tagitems )
D0 A0 A1 D0 A2
STRPTR FindMatchReq( STRPTR, STRPTR, ULONG, struct TagItem * );
name = FindMatchReqTags( match, buffer, len, Tag1, ... )
STRPTR FindMatchReqTags( STRPTR, STRPTR, ULONG, ULONG, ...);
FUNCTION
Scans the datafile for files/dirs matching the match parameter. If
more than one file/dir match a requester will pop up asking the user
to select. The name the user selected is returned.
INPUTS
match - Pointer to string to find.
buffer - Buffer to hold the result.
len - Number of bytes of space in buffer.
tagitems - pointer to TagItem array.
Here are the TagItem.ti_Tag values that are defined for
FindMatchReq().
QT_ScanType - What to scan for. Defined values for ti_Data are:
QT_SCAN_DIRECTORY - Scan for directorys.
QT_SCAN_FILE - Scan for files.
Default scantype is QT_SCAN_FILE.
QT_ReqTitle - Title to use in the title of the requester window is
in (STRPTR) ti_Data. Default is "Select file" for QT_SCAN_FILE
and "Select directory" for QT_SCAN_DIRECTORY.
QT_CenterReq - Center the requester on the screen if (BOOL) ti_Data
is TRUE. Default is TRUE.
QT_PubScreen - Name of the public screen to open requster on is
pointed by (STRPTR) ti_Data. Default is to open on default
public screen. Will also fallback to the default public screen if
LockPubScreen() fails on QT_PubScreen.
RESULT
name - Pointer to a string matching the match parameter.
If there are no match a null-pointer is returned. On failure
IoErr() contains a secondary result. If the buffer is too
small, a null-pointer is returned and IoErr() ==
ERROR_OBJECT_WRONG_TYPE.
EXAMPLE
NOTES
BUGS
SEE ALSO
quicktools.library/FindNextMatch quicktools.library/FindNextMatch
NAME
FindNextMatch -- Find next name that matches.
SYNOPSIS
name = FindNextMatch( matchdata, buffer, len )
D0 A0 A1 D0
STRPTR FindNextMatch( APTR, STRPTR, ULONG );
FUNCTION
Finds the next name that matches the match parameter used when
calling SetupMatchData(). When there are no more matches a NULL
pointer is returned.
INPUTS
matchdata - Pointer returned from SetupMatchData().
buffer - Buffer to hold the result.
len - Number of bytes of space in buffer.
RESULT
name - Pointer to a string matching the match parameter.
If there are no match a null-pointer is returned. On failure
IoErr() contains a secondary result. If the buffer is too
small, a null-pointer is returned and IoErr() ==
ERROR_OBJECT_WRONG_TYPE.
EXAMPLE
NOTES
BUGS
SEE ALSO
SetupMatchData(), FreeMatchData()
quicktools.library/FreeMatchData quicktools.library/FreeMatchData
NAME
FreeMatchData -- Free memory allocated with SetupMatchData()
SYNOPSIS
FreeMatchData( matchdata )
A0
void FreeMatchData( APTR );
FUNCTION
Frees memory allocated with SetupMatchData() to hold matchdata
structure and buffers. Should be called as soon as possible after
all necesary calls to FindNextMatch() are done.
INPUTS
matchdata - Pointer returned from SetupMatchData().
RESULT
EXAMPLE
NOTES
This funtion is safe to call with a NULL pointer.
BUGS
SEE ALSO
SetupMatchData(), FindNextMatch()
quicktools.library/LockQToolsData quicktools.library/LockQToolsData
NAME
LockQToolsData -- Lock QuickTools Data files.
SYNOPSIS
LockQToolsData()
void LockQToolsData( void );
FUNCTION
Gains exclusive access to the datafiles for QuickTools. Used by
GetQInfo when updating the datafiles. This function wil not return
until the the exlusive access is obtained.
INPUTS
RESULT
EXAMPLE
NOTES
After calling LockQToolsData(), UnLockQToolsData() *must* be called
before using any of the other funtions in the library.
Do *not* call this function if you have any allocated matchdata.
Let's repeat it: Free *all* your matchdata *before* calling this
function.
This function is provided so extern programs can update the datafiles
without worring about other tasks pokeing around with the datafiles.
BUGS
SEE ALSO
UnLockQToolsData()
quicktools.library/SetupMatchData quicktools.library/SetupMatchData
NAME
SetupMatchData -- Setup buffers and initialize matchdata structure.
SYNOPSIS
matchdata = SetupMatchData( match, tagitems )
D0 A0 A1
APTR SetupMatchData( STRPTR, struct TagItem * );
matchdata = SetupMatchDataTags( match, Tag1, ... )
APTR SetupMatchDataTags(STRPTR, ULONG, ... );
FUNCTION
Sets up buffers and initilaizes a matchdata structure to be used in
the following calls to FindNextMatch().
INPUTS
match - Pointer to string to find.
tagitems - pointer to TagItem array.
Here are the TagItem.ti_Tag values that are defined for
SetupMatchData().
QT_ScanType - What to scan for. Defined values for ti_Data are:
QT_SCAN_DIRECTORY - Scan for directorys.
QT_SCAN_FILE - Scan for files.
Default scantype is QT_SCAN_FILE.
QT_ExactLastPart - Don't add '#?' to the last part of the given
match if (BOOL) ti_Data is TRUE.
QT_ExactMatch - Don't add any '#?' to the given match if (BOOL)
ti_Data is TRUE.
RESULT
matchdata - Pointer to a machdata structure to be used when calling
FindNextMatch() and FreeMatchData(). On failure a NULL pointer
is returned, and a secondary result can be found in IoErr().
EXAMPLE
NOTES
BUGS
SEE ALSO
FindNextMatch(), FreeMatchData()
quicktools.library/UnLockQToolsData quicktools.library/UnLockQToolsData
NAME
UnLockQToolsData -- UnLock QuickTools Data files.
SYNOPSIS
UnLockQToolsData()
void UnLockQToolsData( void );
FUNCTION
Frees the exclusive access to the datafiles gained by
LockQToolsData(). This function also flushes the internal buffers.
INPUTS
RESULT
EXAMPLE
NOTES
BUGS
SEE ALSO
LockQToolsData()